home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / print / prform17.zip / PRFORM.DOC < prev    next >
Text File  |  1988-06-16  |  17KB  |  397 lines
  1.      
  2.      
  3.      
  4.      PRFORM(1)                 USER COMMANDS                 PRFORM(1)
  5.      
  6.      
  7.      
  8.      NAME
  9.           PRFORM - A PRintout FORMatter in C
  10.      
  11.      SYNOPSIS
  12.           PRFORM is invoked by a command line of the following form:
  13.      
  14.                prform [[-option -option ...] file1 file2 ...] ...
  15.      
  16.                                      - or -
  17.      
  18.                           prform [-option -option ...]
  19.      
  20.           where the options preceeding each group of files specify the
  21.           format  of the output for that group of files.  In the first
  22.           form, PRFORM acts on the  specified  files;  in  the  second
  23.           form, PRFORM acts on standard input.
  24.      
  25.           Options are:
  26.      
  27.             -a       as-is output (expand tabs and page breaks only)
  28.             -e#      end printing after the #th page
  29.             -E       no ending line number in page count
  30.             -hfMprt  sets the page heading
  31.                f   places the file name into the page heading
  32.                M   places the header message (defined by -M)
  33.                     into the page heading
  34.                p   places the page number into the page heading
  35.                r   places the rest of the heading on the right side
  36.                t   places the date and time into the page heading
  37.                    no option after h sets no page heading
  38.                     (default option sequence is frp)
  39.             -hefMprt sets the page heading for even pages
  40.                     (default option sequence is )
  41.             -hofMprt sets the page heading for odd pages
  42.                     (default option sequence is )
  43.             -H       prints this help message on stderr and exits
  44.             -l#      is the length of a line (def 80)
  45.             -m#      is the length of the left margin (def 5)
  46.             -M<text> sets the header message to <text>
  47.             -n       causes each line to be numbered (-M set to 8)
  48.             -o<name> redirects the output listing to the indicated file
  49.             -p#      is the number of lines/page (def 62)
  50.             -s#      start printing at the #th page (def 1)
  51.                     (note: also does -S#, setting first page number)
  52.             -S#      sets the number of the first printed page
  53.             -t#      is the number of columns per tab stop (def 8)
  54.             -T       truncate lines which are too long
  55.      
  56.      
  57.      DESCRIPTION
  58.           PRFORM generates a formatted listing of  one  or  more  text
  59.           files.   The listing can include features such as headers at
  60.      
  61.      
  62.      
  63.      Sun Release 3.2     Last change: 16 June 1988                   1
  64.      
  65.      
  66.      
  67.      
  68.      
  69.      
  70.      PRFORM(1)                 USER COMMANDS                 PRFORM(1)
  71.      
  72.      
  73.      
  74.           the top of each page, numbers in front of  each  line,  wra-
  75.           paround  if  lines  exceed  the width of a page, page breaks
  76.           after an indicated number of lines, etc.   The  listing  can
  77.           start on a specified page if desired.  PRFORM sends its out-
  78.           put to either standard output (default) or a text file.
  79.      
  80.           PRFORM functions as either a conventional program,  process-
  81.           ing  files  specified  on  its command line, or as a filter,
  82.           obtaining its input from standard input.  If  no  files  are
  83.           specified  on  the command line (only zero or more options),
  84.           then PRFORM inputs from standard input.
  85.      
  86.           Most of the options to PRFORM  are  self-explanatory.   Each
  87.           group  of  options  encountered in the command line causes a
  88.           reset to the default options and then a setting of the indi-
  89.           cated  options,  so previous options selections are overrid-
  90.           den; example:
  91.      
  92.                prform -a -m5 file1 -m0 file2
  93.                       \____/       \_/
  94.                      Group 1      Group 2
  95.      
  96.                file1 is printed as-is with a 5-char margin
  97.                file2 is printed with all defaults and no margin
  98.      
  99.      
  100.      
  101.      
  102.                                     _A_s-_I_s _O_u_t_p_u_t
  103.      
  104.           The -a option causes the  file  to  be  output  as-is.   All
  105.           option are set by this command to the following values:
  106.      
  107.                Lines are not truncated.
  108.      
  109.                No heading is output (default heading, even-page  head-
  110.                ing, and odd-page heading are cleared).
  111.      
  112.                Line length is set to the maximum allowed for the  pro-
  113.                gram (400 characters).
  114.      
  115.                Left margin is set to zero.
  116.      
  117.                Line numbering is turned off.
  118.      
  119.                Number of lines per page is set to zero (no paging).
  120.      
  121.                Starting page is set to 1.
  122.      
  123.                Tab stops are set to every 8.
  124.      
  125.      
  126.      
  127.      
  128.      
  129.      Sun Release 3.2     Last change: 16 June 1988                   2
  130.      
  131.      
  132.      
  133.      
  134.      
  135.      
  136.      PRFORM(1)                 USER COMMANDS                 PRFORM(1)
  137.      
  138.      
  139.      
  140.           The -a option can be followed by other options, such as -m#,
  141.           to set a bare output with the exception of some minimum pro-
  142.           cessing (such as a left margin).
  143.      
  144.      
  145.      
  146.                          _L_i_n_e _W_r_a_p_a_r_o_u_n_d _a_n_d _T_r_u_n_c_a_t_i_o_n
  147.      
  148.           If the length of a line exceeds  the  number  of  characters
  149.           specified  by the -l (ell) option or its default value, that
  150.           line will either wrap around to the next line of  the  prin-
  151.           tout  or  be  truncated.  If the -T option is specified, the
  152.           line will be truncated; if not, the line will  wrap  around,
  153.           and  the  continuation  line is prefixed by two greater than
  154.           signs (>>) on the far left.
  155.      
  156.             -_l_7_0 sets the line length to 70 characters total  (includ-
  157.                ing the left margin).
  158.      
  159.             -_l_7_0 -_m_1_0 sets the line length to 70  characters  and  the
  160.                left margin to 10.  There is a maximum of 60 characters
  161.                in each output line.
  162.      
  163.             -_T -_l_5_0 sets the line length to 50 characters and  enables
  164.                truncation  of  any  characters beyond column 50 in the
  165.                generated listing.
  166.      
  167.      
  168.      
  169.                          _P_a_g_e _R_a_n_g_e_s _a_n_d _P_a_g_e _N_u_m_b_e_r_i_n_g
  170.      
  171.           The -s# and -e# commands set the starting  and  ending  page
  172.           boundaries.   If  the  -s#  command is not given, the output
  173.           starts at the first page.  If the -e# command is not  given,
  174.           the  output  ends  at the last page.  The arguments to these
  175.           commands are absolute page numbers, indicating the nth  phy-
  176.           sical  page  in  the listing.  This is as opposed to the -S#
  177.           command.
  178.      
  179.           The -S# command sets the number of  the  first  page  to  be
  180.           printed.   If  the  -S# command is not given, this number is
  181.           the same as the absolute number of the  first  printed  page
  182.           (same  as  the number given in the -s# command).  The number
  183.           given by the -S# command is the number that appears  in  the
  184.           page  heading  for  the  first  page  printed, and each page
  185.           printed after that is incremented from this starting number.
  186.      
  187.           The -E command causes the page numbers printed in the  head-
  188.           ing  to  omit the " of n" part of the output (eg, without -E
  189.           the heading contains "Page 1 of 5", but with -E the  heading
  190.           contains "Page 1").
  191.      
  192.      
  193.      
  194.      
  195.      Sun Release 3.2     Last change: 16 June 1988                   3
  196.      
  197.      
  198.      
  199.      
  200.      
  201.      
  202.      PRFORM(1)                 USER COMMANDS                 PRFORM(1)
  203.      
  204.      
  205.      
  206.             -_s_5 -_e_7 causes  the  5th  through  the  7th  pages  to  b